Authorizations API
Technical Notes
Endpoints
/omaha/authorizations.get:
Note: pass "any" for paramater value authorizationType to see all authorization types.
/omaha/authorization-result.get:
Cash Advance Note
- This API may be required in order to determine the approval or decline of a cash advance depending on how a merchant is set up.
- To run /omaha/authorization-result.get, this will require leveraging the āreferenceNumberā from /omaha/transactions/cash-advance, which determines whether the authorization was processed outside of Co-op (indicated with a value greater than zero).
- Use ARD_REF_NMBR returned as the value for the referenceNumber parameter.
- In the Beta environment, the cash advance process may cause this endpoint to produce inaccurate and/or inconsistent results. In production, authorizations are sent to MasterCard or Visa.
- However, the test environment is not set up this way.
Refer to the Authorization Reason Codes below under Resources for a complete list of valid codes for the parameter - AR_H_ADD_ACTION_IND.
Refer to Match data table below for field cross ref.
/omaha/authorizations/adjustment:
Note: pay attention to amount parameter as it does not take in decimal. Amount with decimal should be multipled by 100 to remove decimal. Example: $150.00 = 15000
/omaha/authorizations/cash-advance:
Note: pay attention to amount parameter as it does not take in decimal. Amount with decimal should be multipled by 100 to remove decimal. Example: $150.00 = 15000
/omaha/outstanding-authorizations.get:
Note: will return all outstanding authorizations.
/connex/authorization-override.get:
This endpoint may require multiple calls depending on how large your page size is.
To view Limit types and meanings, please refer to the Limit Type IDs below.
Note: please validate with your Financial Institution's settings to know which limits are available to your financial institution.
/connex/authorization-override POST:
To view Limit types and meanings, please refer to the Limit Type IDs below.
If beginDate and endDate are not set it will be overriden indefinetly.
Note: please validate with your Financial Institution's settings to know which limits are available to your financial institution.
/connex/authorization-override PUT:
To view Limit types and meanings, please refer to the Limit Type IDs below.
If beginDate and endDate are not set it will be overriden indefinetly.
Note: please validate with your Financial Institution's settings to know which limits are available to your financial institution.
/connex/authorization-override.delete:
Note: please validate with your Financial Institution's settings to know which limits are available to your financial institution.
/connex/authorization-accountholds.get:
This endpoint may require multiple calls depending on how large your page size is.
/connex/authorization-accountholds.delete:
Note: please validate with your Financial Institution's settings to know which limits are available to your financial institution.
/connex/authorization-card-accountholds.get:
This endpoint may require multiple calls depending on how large your page size is.
/connex/authorization-limitholds.delete:
Note: please validate with your Financial Institution's settings to know which limits are available to your financial institution.
/connex/authorization-limitholds.get:
This endpoint may require multiple calls depending on how large your page size is.
Note: please validate with your Financial Institution's settings to know which limits are available to your financial institution.
Resources
Limit Type IDs
This table contains a list of Limit Types IDs
| Description | Limit Type Name |
|---|---|
| Withdrawals | WDR020 WDR021 |
| Online Withdrawals | WDR040 WDR041 |
| Purchases | PUR020 PUR021 |
| Purchases (VC/MM) | PUR030 PUR031 |
| Purchases VM Shared Usage | PUR032 PUR033 |
| Online Purchases | PUR040 PUR041 |
| Online Purchases (VC/MM) | PUR050 PUR051 |
| Online Purch VM Shared Usage | PUR052 PUR053 |
| Purchases | PPA020 PPA021 |
| Total Purchases VM/Regional | TPU020 TPU021 |
| Online Total Purchases VM/Regional | TPU040 TPU041 |
| Total Debit Activity | TDB020 TDB021 |
| Online Total Debit Activity | TDB040 TDB041 |
| Balance Inquiries | BAL020 BAL021 |
| Online Balance Inquiries | BAL040 BAL041 |
| Deposits/Payments | DEP020 DEP021 |
| Online Deposits/Payments | DEP040 DEP041 |
| Check Deposits | DEP060 DEP061 |
| Online Check Deposits | DEP080 DEP081 |
| Available Deposits | AVD020 AVD021 |
| Online Available Deposits | AVD040 AVD041 |
| Available Payments | AVP020 AVP021 |
| Online Available Payments | AVP040 AVP041 |
| Visa Funds Transfer | AFT020 AFT021 |
| Online Visa Funds Transfer | AFT040 AFT041 |
| Available Transfers | AVT020 AVT021 |
| Transfers | TFR020 TFR021 |
| Online Transfers | TFR040 TFR041 |
| Purchase Returns | PRE020 PRE021 |
| Online Purchase Returns | PRE040 PRE041 |
| Cash Back | CSB020 CSB021 |
| Online Cash Back | CSB040 CSB041 |
| Unlimited Availability | UAV020 UAV021 |
| Payments from 3rd Party | PAY020/040 PFT020/040 |
Authorization Reason Codes
The Authorization Reason Codes table references a complete list of valid codes for the parameter -
AR_-H-_ADD-_ACTION-_IND in the endpoint - /omaha/authorization-result.get.
| Code | Authorization Reason |
|---|---|
| 00 | No additional action specified |
| 01 | Authorization by expansion |
| 02 | Get new address |
| 03 | Get positive identification |
| 04 | Call me |
| 05 | Pick up card |
| 06 | Invalid card number |
| 07 | Invalid merchant number |
| 08 | Invalid amount |
| 09 | Merchant not on file |
| 0A | Non-FDR cardholder and merchant |
| 0B | Processor record not found |
| 0C | Invalid merchant assessment code |
| 0D | Closed merchant |
| 0E | Invalid expiration date |
| 0F | Invalid mail order flag |
| 10 | Over single authorization limit |
| 11 | Over cash advance single limit |
| 12 | Under cash advance minimum |
| 13 | Overlimit |
| 14 | File error |
| 15 | Cardholder record not found |
| 16 | Excessive transactions |
| 17 | Over cash advance total limit |
| 18 | Use external status as reason |
| 19 | Use internal status as reason |
| 1A | Invalid ETC (Electronic Ticket Capture) transaction type |
| 1B | Not ETC merchant |
| 1C | Ask for transaction type |
| 1D | Only ETC transaction type 4 valid |
| 1E | Cardholder invalid for merchant |
| 1F | Attala box down |
| 20 | Aborted call |
| 21 | VIP status |
| 22 | Transmit name BASE/INAS |
| 23 | Center closed |
| 24 | Card number on negative file |
| 25 | Communication line down |
| 26 | Bad read CVV |
| 27 | Bad stripe CVV |
| 28 | COV - MCC/CTY/ZIP |
| 29 | Invalid PIN point phone number |
| 2A | Merchant on wrong system |
| 2B | Cardholder on wrong system |
| 2C | Over daily spending limit |
| 2D | BASE response - below minimum |
| 2E | Invalid PIN number |
| 2F | PIN service unavailable |
| 30 | Excessive PIN transactions |
| 31 | BASE I System error |
| 32 | Card use exceeded maximum |
| 33 | Rejected PIN |
| 34 | Authorization approval of partial amount |
| 35 | Rejected PIN for invalid block format |
| 36 | Rejected for invalid encrypted PIN |
| 37 | INAS - invalid ATM terminal identification |
| 38 | Invalid transaction type |
| 39 | Function unavailable |
| 3A | Referral |
| 3B | Have merchant do CALL ME |
| 3C | Display optional data only |
| 3D | ETC files disabled |
| 3E | Manual decline |
| 3F | Exceeds commercial card spending limit |
| 40 | Commercial card - company overlimit |
| 41 | Diversion account delinquent |
| 42 | INAS manual reject - Invalid PIN |
| 43 | Diversion account overlimit |
| 44 | Diversion account delinquent and overlimit |
| 45 | Diversion account exceeds spending limit |
| 46 | Relationship ProcessingĀ® service - overlimit/family level |
| 47 | Relationship ProcessingĀ® service - family not active |
| 48 | Diversion account |
| 49 | Invalid CVV2/CVC2 value entered |
| 4A | Name mismatch track one |
| 4B | Verify order |
| 4C | Payment reversal does not match to payment |
| 4D | ETC Plus credit item gap > 200 |
| 4E | Invalid loan officer identification |
| 4F | Duplicate authorization |
| 50 | Not signed on |
| 51 | Authorization System malfunction |
| 52 | Invalid prefix for DES PIN |
| 53 | Message format problem |
| 54 | Decline reason set |
| 55 | Service not available |
| 56 | Over merchandise total limit |
| 57 | Display name meets counterfeit parameters |
| 58 | On Combined Warning Bulletin flag was set |
| 59 | Invalid SE number - AMEX |
| 5A | New/reissue declined |
| 5B | New/reissue get positive identification |
| 5C | Issuer center down |
| 5D | Invalid department code |
| 5E | ETC retry code |
| 5F | Decline āYā authorization flag |
| 60 | No matching detail ETC void/reversal |
| 61 | Lost card |
| 62 | Stolen card |
| 63 | Stop payment on check |
| 64 | Unable to authorize |
| 65 | Vendor not on company card vendor list |
| 66 | ETC - invalid batch sequence number |
| 67 | ETC - batch has reached item limit |
| 68 | Over JCB limit-transfer to Jesta network |
| 69 | Invalid service restriction code |
| 6A | Invalid CVV value |
| 6B | Rejected CVV |
| 6C | Invalid ticket terms |
| 6D | Consecutive authorization over PCF cash limit |
| 6E | Authorization prior to valid date |
| 6F | Issuer not permitted ATM inquiries |
| 70 | COV - HIGH/LOW |
| 71 | No match on preapproved authorization |
| 72 | Excessive transactions, get positive identification |
| 73 | Excessive PIN attempts, get positive identification |
| 74 | Card verification declined |
| 75 | Card verification get positive identification |
| 76 | Do not honor |
| 77 | Insufficient funds |
| 78 | Account closed |
| 79 | Card statused severity 1 |
| 7A | Card statused severity 4 |
| 7B | Card statused severity 4 |
| 7C | Account statused |
| 7D | Less than minimum amount required |
| 7E | Card statused severity 2 |
| 7F | Card statused severity 5 |
| 80 | Re-enter transaction |
| 81 | File temporarily unavailable |
| 82 | Card expired on Master File |
| 83 | Mismatched expiration date |
| 84 | Decline for NRI (not received as issued) |
| 85 | NRI get positive identification |
| 86 | Decline counterfeit |
| 87 | Counterfeit get positive identification |
| 88 | Decline kiting |
| 89 | Kiting get positive identification |
| 8A | Decline lost/stolen |
| 8B | Lost/stolen get positive identification |
| 8C | Invalid item count |
| 8D | Invalid type change |
| 8E | Always Refer Flag set |
| 8F | Chip card authentication failure |
| 90 | Invalid fleet ID |
| 91 | Invalid fleet driver ID |
| 92 | Invalid fleet vehicle ID |
| 93 | Force standin at Association (Visa/MC) |
| 94 | Rejected 3D secure CAVV value |
| 95 | Invalid 3D secure CAVV value |
| 96 | Invalid PI external status |
| 97 | PI not on file |
| 98 | Ticket terms not active |
| 99 | Invalid ticket terms amount |
| 9A | Invalid MC UCAF value |
| 9B | No match found on āQā Request |
| 9C | Declined stop recurring payment |
| 9D | Invalid claim number |
| 9E | Reserved for restricted use |
| 9F | Reserved for restricted use |
| A0 | Reserved for restricted use |
| A1 | Reserved for restricted use |
| A2 | Reserved for restricted use |
| A3 | Client-defined decline reason code |
| A4 | Reserved for healthcare processors |
| A5 | Excessive transactions - PI |
| A6 | Account day hour restricted |
| A7 | ID day hour restricted |
| A8 | Reserved for healthcare processors |
| A9 | Reserved for healthcare processors |
| AA | Chip record not found |
| AB | Invalid ARQC |
| AC | Check not activated |
| AD | Real time decisioning decline |
| AE | Reserved for healthcare processors |
| AF | Commercial card super company overlimit |
| B0 | Consumer control decline |
| B1 | Commercial - TAN (Transaction Account Number) amount doesnāt match |
| B2 | Commercial - TAN (Transaction Account Number) out of date range |
| B3 | Surcharge not allowed on debit |
| B4 | Prepaid non-reloadable cash back |
Match Data
Match Data is the data used to associate the authorized item to the settled item. The following defined match data types include POS Pre-Authorization, Debit Master Card, Visa Check with Transaction Identifiers, Visa Check without Transaction Identifiers.
POS Pre-Authorization
- Positions 1-12: Last 12 digits of the card number performing the transaction that placed the hold.
- Positions 13-27: The Terminal Reference is the number from the terminal used in the transaction.
- Position 28: P (standard POS pre-authorization)
- Positions 29-30: Blank Fill
- Positions 31-36: The authorization number for the hold transaction. Use the AP or online host assigned authorization number.
Debit MasterCardĀ®
- Positions 1-12: Last 12 digits of the card number performing the transaction that placed the hold.
- Positions 13-27: Terminal Reference is the number from the terminal used in the transaction.
- Position 28: M (Debit MasterCardĀ® transaction)
- Positions 29-30: Terminal Day is the 2-digit day of the month when the original transaction occurred.
- Positions 31-36: The authorization number for the hold transaction. Use the AP or online host assigned authorization number.
Visa Checkā¢ with Transaction Identifiers
- Positions 1-12: Last 12 digits of the card number performing the transaction that placed the hold.
- Positions 13-27: The VisaĀ® Transaction Identifier for this transaction.
- Position 28: V (Visa Checkā¢ transaction)
- Positions 29-30: Terminal Day is the 2-digit day of the month when the original transaction occurred.
- Positions 31-36: The authorization number for the hold transaction. Use the AP or online host assigned authorization number.
Visa Checkā¢ without Transaction Identifiers
- Positions 1-2: Last 12 digits of the card number performing the transaction that placed the hold.
- Positions 13-20: The Terminal Reference number from the terminal used in the transaction.
- Positions 21-27: Blank or Space fill
- Position 28: V (Visa Check transaction)
- Positions 29-30: Terminal Day is the 2-digit day of the month when the original transaction occurred.
- Positions 31-36: The authorization number for the hold transaction. Use the AP or online host assigned authorization number.